Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NOISSUE - Use github action for showing OpenAPI spec with Swagger UI #1427

Merged
merged 20 commits into from
Jun 23, 2021

Conversation

blokovi
Copy link
Contributor

@blokovi blokovi commented Jun 17, 2021

Signed-off-by: Ivan Milosevic iva@blokovi.com

What does this do?

  • Use github action for deploying Swagger UI with github pages on custom domain (api.mainflux.io)
  • All API specification files moved to one /api folder
  • Fix semantic error in openAPI specification for Auth

Which issue(s) does this PR fix/relate to?

No issue

@blokovi blokovi requested a review from a team as a code owner June 17, 2021 06:39
@codecov-commenter
Copy link

codecov-commenter commented Jun 17, 2021

Codecov Report

Merging #1427 (ab02033) into master (0a89f1d) will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1427      +/-   ##
==========================================
- Coverage   69.26%   69.24%   -0.03%     
==========================================
  Files         123      123              
  Lines        8454     8454              
==========================================
- Hits         5856     5854       -2     
- Misses       2072     2074       +2     
  Partials      526      526              
Impacted Files Coverage Δ
things/service.go 68.08% <0.00%> (-1.42%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0a89f1d...ab02033. Read the comment docs.

manuio
manuio previously approved these changes Jun 17, 2021
Copy link
Contributor

@manuio manuio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

darkodraskovic
darkodraskovic previously approved these changes Jun 17, 2021
Copy link
Contributor

@darkodraskovic darkodraskovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

drasko
drasko previously approved these changes Jun 22, 2021
Copy link
Contributor

@drasko drasko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

dborovcanin
dborovcanin previously approved these changes Jun 23, 2021
Copy link
Collaborator

@dborovcanin dborovcanin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check if API docs are referenced in README files for respective services and fix those references, as well.

Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
Signed-off-by: Ivan Milosevic <iva@blokovi.com>
manuio
manuio previously approved these changes Jun 23, 2021
Copy link
Contributor

@manuio manuio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Ivan Milosevic <iva@blokovi.com>
@blokovi
Copy link
Contributor Author

blokovi commented Jun 23, 2021

Please check if API docs are referenced in README files for respective services and fix those references, as well.

Thanks @dusanb94 , done.

@@ -103,6 +103,6 @@ If `MF_EMAIL_TEMPLATE` doesn't point to any file service will function but passw
## Usage

For more information about service capabilities and its usage, please check out
the [API documentation](openapi.yml).
the [API documentation](https://api.mainflux.io/?urls.primaryName=auth-openapi.yml).
Copy link
Contributor

@manuio manuio Jun 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this url? It should be api/auth-openapi.yml, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes @manuio , raw yml file is there. But on api.mainflux.io domain, it will be shown in SwaggerUI which is more user friendly

Copy link
Contributor

@manuio manuio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@drasko drasko merged commit cddfdf4 into absmach:master Jun 23, 2021
@blokovi blokovi deleted the swaggerui branch June 23, 2021 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants